home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3dm / audio / alGetEventData.z / alGetEventData
Encoding:
Text File  |  1998-10-20  |  4.4 KB  |  133 lines
  1.  
  2.  
  3.  
  4. aaaallllGGGGeeeettttEEEEvvvveeeennnnttttDDDDaaaattttaaaa((((3333ddddmmmm))))                                        aaaallllGGGGeeeettttEEEEvvvveeeennnnttttDDDDaaaattttaaaa((((3333ddddmmmm))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      alGetEventData - gets data from certain events with non-scalar
  10.      parameters.
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      ####iiiinnnncccclllluuuuddddeeee <<<<ddddmmmmeeeeddddiiiiaaaa////aaaauuuuddddiiiioooo....hhhh>>>>
  14.  
  15.      vvvvooooiiiidddd**** aaaallllGGGGeeeettttEEEEvvvveeeennnnttttDDDDaaaattttaaaa((((AAAALLLLeeeevvvveeeennnntttt eeeevvvveeeennnntttt))))
  16.  
  17.  
  18. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRR
  19.      _e_v_e_n_t   expects an AAAALLLLeeeevvvveeeennnntttt structure initialized by aaaallllNNNNeeeexxxxttttEEEEvvvveeeennnntttt((((3333ddddmmmm)))) or
  20.              aaaallllCCCChhhheeeecccckkkkEEEEvvvveeeennnntttt((((3333ddddmmmm)))).
  21.  
  22. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  23.      aaaallllGGGGeeeettttEEEEvvvveeeennnnttttDDDDaaaattttaaaa returns the event data information as a void pointer. This
  24.      call is used on certain non-scalar event parameters. Refer to
  25.      aaaallllPPPPaaaarrrraaaammmmssss((((3333ddddmmmm)))) for a complete list of parameters that return event
  26.      information through aaaallllGGGGeeeettttEEEEvvvveeeennnnttttDDDDaaaattttaaaa((((3333ddddmmmm)))).
  27.  
  28.      After reading the event data, the void pointer should be cast to an event
  29.      information struct.  Again, refer to aaaallllPPPPaaaarrrraaaammmmssss((((3333ddddmmmm)))) for a complete list
  30.      event information structs.
  31.  
  32.  
  33. EEEEXXXXAAAAMMMMPPPPLLLLEEEE
  34.      The following code fragment shows how to retrieve data from events with
  35.      parameters of type AL_CONNECT.
  36.  
  37.  
  38.           ALeventQueue     eventq;
  39.           ALevent          event;
  40.           ALconnectionInfo *info;
  41.                .
  42.                .
  43.           /*
  44.            * Get event from event queue
  45.            */
  46.           alNextEvent(eventq,event);
  47.           switch(alGetEventParam(event)) {
  48.           case AL_CONNECT:
  49.               conn_info = (ALconnectionInfo *)alGetEventData(event);
  50.                 .
  51.                 .
  52.                 .
  53.               break;
  54.                 .
  55.                 .
  56.                 .
  57.           }
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. aaaallllGGGGeeeettttEEEEvvvveeeennnnttttDDDDaaaattttaaaa((((3333ddddmmmm))))                                        aaaallllGGGGeeeettttEEEEvvvveeeennnnttttDDDDaaaattttaaaa((((3333ddddmmmm))))
  71.  
  72.  
  73.  
  74. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  75.      Upon successful completion, aaaallllGGGGeeeettttEEEEvvvveeeennnnttttDDDDaaaattttaaaa((((3333ddddmmmm)))) returns a void pointer.
  76.      Otherwise it returns NULL, and sets an error number. This error number
  77.      can be retrieved with oooosssseeeerrrrrrrroooorrrr((((3333CCCC)))).
  78.  
  79.      aaaallllGGGGeeeettttEEEEvvvveeeennnnttttDDDDaaaattttaaaa can fail for the following reason:
  80.  
  81.      AAAALLLL____BBBBAAAADDDD____IIIINNNNVVVVAAAALLLLIIIIDDDD____EEEEVVVVEEEENNNNTTTT   _e_v_e_n_t is invalid or null.
  82.  
  83. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  84.      alNewEvent(3dm), alNextEvent(3dm), alCheckEvent(3dm), alParams(3dm),
  85.      alGetEventParam(3dm), alGetEventValue(3dm), alGetParams(3dm), oserror(3C)
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.